New Utils\MessageHelper class
#249
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jrfnl
force-pushed
the
feature/new-message-helper-class
branch
from
25e1249
to
2bf2013
Compare
This class initially introduces five new utility methods for working with error/warning messages.
The class currently contains the following methods:
* `addMessage()` - simple method to add either an error or a warning to PHPCS based on an `$isError` parameter. Returns boolean (same as PHPCS natively).
Supports all optional parameters supported by PHPCS.
* `addFixableMessage()` - simple method to add either a fixable error or a fixable warning to PHPCS based on an `$isError` parameter. Returns boolean (same as PHPCS natively).
Supports all optional parameters supported by PHPCS.
* `stringToErrorcode()` - to convert an arbitrary text string to an alphanumeric string with underscores. Returns the adjusted text string.
This method is intended to pre-empt issues in XML and PHP when arbitrary text strings are used as (part of) an error code.
* `hasNewLineSupport()` - to check whether PHPCS can properly handle new lines in violation messages.
Prior to PHPCS 3.3.1, new line support in error messages was buggy.
Ref: squizlabs/PHP_CodeSniffer#2093
* `showEscapeChars()` - to make the whitespace escape codes used in an arbitrary text string visible. Returns string.
Includes dedicated unit tests for each method.
jrfnl
force-pushed
the
feature/new-message-helper-class
branch
from
157d2bb
to
581c21a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This class initially introduces five new utility methods for working with error/warning messages.
The class currently contains the following methods:
addMessage()- simple method to add either an error or a warning to PHPCS based on an$isErrorparameter. Returns boolean (same as PHPCS natively).Supports all optional parameters supported by PHPCS.
addFixableMessage()- simple method to add either a fixable error or a fixable warning to PHPCS based on an$isErrorparameter. Returns boolean (same as PHPCS natively).Supports all optional parameters supported by PHPCS.
stringToErrorcode()- to convert an arbitrary text string to an alphanumeric string with underscores. Returns the adjusted text string.This method is intended to pre-empt issues in XML and PHP when arbitrary text strings are used as (part of) an error code.
hasNewLineSupport()- to check whether PHPCS can properly handle new lines in violation messages.Prior to PHPCS 3.3.1, new line support in error messages was buggy.
Ref: Report Full: various message formatting fixes squizlabs/PHP_CodeSniffer#2093
showEscapeChars()- to make the whitespace escape codes used in an arbitrary text string visible. Returns string.Includes dedicated unit tests for each method.